home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_300 / 365_02 / options.ms < prev    next >
Text File  |  1992-04-04  |  24KB  |  526 lines
  1. .Go 5 "OPTIONS"
  2. .PP
  3. Options may be set or examined via the colon command "set".
  4. The values of options will affect the operation of later commands.
  5. .PP
  6. For convenience, options have both a long descriptive name and a short name
  7. which is easy to type.
  8. You may use either name interchangably.
  9. I like the short names, myself.
  10. .PP
  11. There are three types of options: Boolean, string, and numeric.
  12. Boolean options are made TRUE by giving the name of the option as an
  13. argument to the "set" command;
  14. they are made FALSE by prefixing the name with "no".
  15. For example, "set autoindent" makes the autoindent option TRUE,
  16. and "set noautoindent" makes it FALSE.
  17. \*E also allows boolean options to be toggled by prefixing the name with "neg".
  18. So, ":map g :set neglist^M" will cause the <g> key to alternately toggle the
  19. "list" option on and off.
  20. (The "neg" prefix is an extension; the real vi doesn't support it.)
  21. .PP
  22. To change the value of a string or numeric option, pass the "set" command
  23. the name of the option, followed by an "=" sign and the option's new value.
  24. For example, "set tabstop=8" will give the tabstop option a value of 8.
  25. For string options, you may enclose the new value in quotes.
  26. .LD
  27. .ta 1.9i 2.4i 3.8i
  28. .ps +2
  29. \fBNAMES    TYPE    DEFAULT    MEANING\fP
  30. .ps
  31. autoindent, ai    Bool    noai    auto-indent during input
  32. autoprint, ap    Bool    ap    in EX, print the current line
  33. autotab, at    Bool    at    auto-indent allowed to use tabs?
  34. autowrite, aw    Bool    noaw    auto-write when switching files
  35. beautify,  bf    Bool    nobf    strip control chars from file?
  36. charattr, ca    Bool    noca    interpret \\fX sequences?
  37. cc, cc    Str    cc="cc -c"    name of the C compiler
  38. columns, co    Num    co=80    width of the screen
  39. digraph, dig    Bool    nodig    recognize digraphs?
  40. directory, dir    Str    dir="/usr/tmp"    where tmp files are kept
  41. edcompatible, ed    Bool    noed    remember ":s//" options
  42. equalprg, ep    Bool    ep="fmt"    program to run for = operator
  43. errorbells, eb    Bool    eb    ring bell on error
  44. exrc, exrc    Bool    noexrc    read "./.exrc" file?
  45. exrefresh, er    Bool    er    write lines indiviually in EX
  46. flash, vbell    Bool    flash    use visible alternative to bell
  47. flipcase, fc    Str    fc=""    non-ASCII chars flipped by ~
  48. hideformat, hf    Bool    hf    hide text formatter commands
  49. ignorecase, ic    Bool    noic    upper/lowercase match in search
  50. inputmode, im    Bool    noim    start vi in insert mode?
  51. keytime, kt    Num    kt=2    timeout for mapped key entry
  52. keywordprg, kp    Str    kp="ref"    full pathname of shift-K prog
  53. lines, ln    Num    ln=25    number of lines on the screen
  54. list, li    Bool    noli    display lines in "list" mode
  55. magic, ma    Bool    ma    use regular expression in search
  56. make, mk    Str    mk="make"    name of the "make" program
  57. mesg, ms    Bool    ms    allow messages from other users?
  58. modelines, ml    Bool    noml    are modelines processed?
  59. more, more    Bool    more    pause between messages?
  60. novice, nov    Bool    nonovice    set options for ease of use
  61. paragraphs, para    Str    para="PPppIPLPQP"    names of "paragraph" nroff cmd
  62. prompt, pr    Bool    pr    show ':' prompt in \fIex\fR mode
  63. readonly, ro    Bool    noro    prevent overwriting of orig file
  64. remap, rem    Bool    remap    allow key maps to call key maps
  65. report, re    Num    re=5    report when 5 or more changes
  66. ruler, ru    Bool    noru    display line/column numbers
  67. scroll, sc    Num    sc=12    scroll amount for ^U and ^D
  68. sections, sect    Str    sect="NHSHSSSEse"    names of "section" nroff cmd
  69. shell, sh    Str    sh="/bin/sh"    full pathname of the shell
  70. showmatch, sm    Bool    nosm    show matching ()[]{}
  71. showmode, smd    Bool    nosmd    say when we're in input mode
  72. shiftwidth, sw    Num    sw=8    shift amount for < and >
  73. sidescroll, ss    Num    ss=8    amount of sideways scrolling
  74. sync, sy    Bool    nosy    call sync() often
  75. tabstop, ts    Num    ts=8    width of tab characters
  76. taglength, tl    Num    tl=0    significant chars in tag name
  77. term, te    Str    te="$TERM"    name of the termcap entry
  78. terse, tr    Bool    notr    give shorter error messages
  79. timeout, to    Bool    to    distinguish <esc> from <arrow>?
  80. warn, wa    Bool    wa    warn for ! if file modified
  81. window, wi    Num    wi=24    lines to redraw after long move
  82. wrapmargin, wm    Num    wm=0    wrap long lines in input mode
  83. wrapscan, ws    Bool    ws    at EOF, searches wrap to line 1
  84. writeany, wr    Bool    nowr    allow :w to clobber files
  85. .DE
  86. .TA
  87. .ne 6
  88. .IP "autoindent, ai"
  89. During input mode, the autoindent option will cause each added line
  90. to begin with the same amount of leading whitespace as the line above it.
  91. Without autoindent, added lines are initially empty.
  92. .IP "autoprint, ap"
  93. This option only affects EX mode.
  94. If the autoprint option on,
  95. and either the cursor has moved to a different line
  96. or the previous command modified the file,
  97. then \*E will print the current line.
  98. .IP "autotab, at"
  99. This option affects the behaviour of the autoindent mode.
  100. If autoindent is turned off, then autotab has no effect.
  101. .IP
  102. When autotab is turned on, elvis will use a mixture of spaces and tabs
  103. to create the proper amount of indentation.
  104. This is the default.
  105. .IP
  106. When autotab is turned off, elvis will only use spaces for auto-indent.
  107. \*E will still insert a real tab character when you hit the <Tab> key, though;
  108. the autotab option only affects \fIautomatic\fR indentation.
  109. .IP "autowrite, aw"
  110. When you're editing one file and decide to switch to another
  111. \- via the :tag command, or :next command, perhaps \-
  112. if your current file has been modified,
  113. then \*E will normally print an error message and refuse to switch.
  114. .IP
  115. However, if the autowrite option is on,
  116. then \*E will write the modified version of the current file
  117. and successfully switch to the new file.
  118. .IP "beautify, bf"
  119. This option causes all control characters to be deleted from the text file,
  120. at the time when you start editing it.
  121. If you're already editing a file when you turn on the beautify option,
  122. then that file won't be affected.
  123. .IP cc
  124. The :cc command runs the C compiler.
  125. This option should be set to the name of your compiler.
  126. .IP "charattr, ca"
  127. Many text formatting programs allow you to designate portions of
  128. your text to be underlined, italicized, or boldface by embedding
  129. the special strings \\fU, \\fI, and \\fB in your text.
  130. The special string \\fP marks the end of underlined or boldface text.
  131. .IP
  132. \*E normally treats those special strings just like any other text.
  133. .IP
  134. However, if the charattr option is on, then \*E will interpret
  135. those special strings correctly,
  136. to display underlined or boldface text on the screen.
  137. (This only works, of course, if your terminal can display
  138. underlined and boldface, and if the TERMCAP entry says how to do it.)
  139. .IP "columns, co"
  140. This option shows how wide your screen is.
  141. .IP "digraph, dig"
  142. This option is used to enable/disable recognition of digraphs.
  143. The default value is nodigraph, which means that digraphs will not be
  144. recognized.
  145. .IP "directory, dir"
  146. \*E stores text in temporary files.
  147. This option allows you to control which directory those temporary files will
  148. appear in.
  149. The default is /usr/tmp.
  150. .IP
  151. This option can only be set in a .exrc file;
  152. after that, \*E will have already started making temporary files
  153. in some other directory, so it would be too late.
  154. .IP "edcompatible, ed"
  155. This option affects the behaviour of the ":s/regexp/text/options" command.
  156. It is normally off (:se noed) which causes all of the substitution options
  157. to be off unless explicitly given.
  158. .IP
  159. However, with edcompatible on (:se ed), the substitution command remembers
  160. which options you used last time.
  161. Those same options will continue to be used until you change them.
  162. In edcompatible mode, when you explicitly give the name of a
  163. substitution option, you will toggle the state of that option.
  164. .IP
  165. This all seems very strange to me, but its implementation was almost free
  166. when I added the ":&" command to repeat the previous substitution,
  167. so there it is.
  168. .IP "equalprg, ep"
  169. This holds the name & arguments of the external filter program
  170. used the the visual = operator.
  171. The defualt value is "fmt",
  172. so the = operator will adjust line breaks in text.
  173. .IP "errorbells, eb"
  174. \*E normally rings a bell when you do something wrong.
  175. This option lets you disable the bell.
  176. .IP exrc
  177. This option specifies whether a .exrc file in the current directory
  178. should be executed.
  179. By default, this option is off (":set noexrc") which prevents elvis from
  180. e